Interface CustomUdpProcess

All Superinterfaces:
IPCObject, Process
All Known Implementing Classes:
CustomUdpProcessImpl

public interface CustomUdpProcess extends Process
Information provided by the PKI file:

    \class CustomUdpProcess
    
    \brief CustomUdpProcess is the process that manipulates the custom UDP process.
    
    \example network().getDevice("Router0").getProcess("UdpProcess").createCustomUdpProcess()
    
Author:
Auto-generated
  • Method Details

    • start

      boolean start(int port)
      Information provided by the PKI file:
      
          \brief Starts the custom UDP process on the specified port number.
          
          \param int, the port number.
          
          \return bool, true if successful, otherwise false.
          
              
      Parameters:
      port - Takes in a parameter of port
      Returns:
      boolean Returns a boolean
    • stop

      boolean stop()
      Information provided by the PKI file:
      
          \brief Stops the custom UDP process.
          
          \return bool, true if successful, otherwise false.
          
              
      Returns:
      boolean Returns a boolean
    • isStarted

      boolean isStarted()
      Information provided by the PKI file:
      
          \brief Returns true if the custom UDP process was started, otherwise false.
          
          \return bool, true if the custom UDP process was started, otherwise false.
          
              
      Returns:
      boolean Returns a boolean
    • getPortNumber

      int getPortNumber()
      Information provided by the PKI file:
      
          \brief Returns the port number of this custom UDP process.
          
          \return int, the port number of this custom UDP process.
          
              
      Returns:
      int Returns a int
    • createFrameInstance

      FrameInstance createFrameInstance(int color, String dstStr)
      Information provided by the PKI file:
      
          \brief Creates a frame instance.
          
          \param color, the color for this frame instance.
          \param dstStr, the destination IP address for this frame instance.
          
          \return FrameInstance, a FrameInstance object.
          
              
      Parameters:
      color - Takes in a parameter of color
      dstStr - Takes in a parameter of dstStr
      Returns:
      FrameInstance Returns a FrameInstance